SftDirectory 2.5

Syntax Conventions Used

Softel vdm, Inc.

The syntax shown in this documentation follows these guidelines. Each property, method and event is shown for Visual Basic.NET (VB.NET), Visual Basic 5/6 (VB), C# (C#.NET), Visual C++ (VC++), C (C) and for Delphi (Delphi).

The syntax for properties shows up to three forms (Get, Put and PutRef) if available, the first to retrieve the property value, the second and third to set the property value.  For most properties, only a Get and Put syntax is shown.  Font and picture properties also allow a third form (PutRef).  If both Put and PutRef is available, PutRef is the preferred form as it conserves resources and assigns a font or picture object reference to the control.  Any change to the font or picture object is reflected in the control also.  Put on the other hand causes the control to completely copy the font or picture object.

Syntax       

Get

VB.NET

refPictureObj = object.Picture  As stdole.IPictureDisp

VB

Set refPictureObj = object.Picture  As IPictureDisp

C#.NET

stdole.IPictureDisp refPictureObj = object.Picture;

VC++

IPictureDisp* refPictureObj = object->GetPicture();

C

HRESULT object->get_Picture(IPictureDisp** refPictureObj);

Delphi

refPictureObj := object.Picture  : IPictureDisp;

Put

VB.NET

object.let_Picture(ByVal refPictureObj As stdole.IPictureDisp)

VB

object.Picture = refPictureObj  As IPictureDisp

C#.NET

void object.let_Picture(stdole.IPictureDisp refPictureObj);

VC++

void object->PutPicture(IPictureDisp* refPictureObj);

C

HRESULT object->put_Picture(IPictureDisp* refPictureObj);

Delphi

procedure object._Set_Picture(refPictureObj : IPictureDisp);

PutRef

VB.NET

object.Picture = refPictureObj  As stdole.IPictureDisp

VB

Set object.Picture = refPictureObj  As IPictureDisp

C#.NET

stdole.IPictureDisp object.Picture = refPictureObj;

VC++

void object->PutRefPicture(IPictureDisp* refPictureObj);

C

HRESULT object->putref_Picture(IPictureDisp* refPictureObj);

Delphi

object.Picture := refPictureObj  : IPictureDisp;

The small image in the Syntax title line above can be used to filter the languages for which the syntax is displayed.  Click on the image in the title and select the language to be displayed.  This setting applies to all help pages and can be changed wherever the image is displayed.

The following conventions are used throughout the reference section:

Description

Example

Syntax shown in blue shows sample use of the property, method or event (VB.NET, VB, C#.NET, Delphi) or shows its definition (VC++, C)

refPictureObj = object.Picture

Syntax shown in gray shows the type of the property, return type of the method or event (VB.NET, VB, C#.NET, Delphi)

As stdole.IPictureDisp
 : IPictureDisp

Words in bold (any color) indicate language keywords or (property, method, event) names.

False
If
Function
BorderStyle

Italic words (any color) indicate placeholders for information, to be supplied by you.

object
index
var

Words in regular font  (any color) indicate text that is used as-is, such as language specific punctuation.

->
get_

Square brackets (any color) indicate optional information when describing Visual Basic (VB). For all other languages, square brackets indicate array indices.

[, arg]

All sample code given in the Example section of a property, method or event usually applies to Visual Basic only unless noted. Visual Basic offers a fairly simple syntax which is generally easily understood, even when not familiar with Visual Basic.  Certain samples are also included for other languages to demonstrate language specific peculiarities when necessary.

All code samples usually assume that a SftDirectory control has been added to a form. All relevant properties, even properties that could be set at design-time using the Property Dialog, are set at run-time to show any dependencies.

More elaborate samples are also available in the product directory \Program Files\Softelvdm\SftDirectory 2.5\Samples\.


Feedback / comments / error reports for this topic
© 2003, 2008 - Softel vdm, Inc. - www.softelvdm.com